<?php
/**
 * <b>RUBIK IT Solution & Development ltd.</b>
 *
 * PROJECT		: Rubik Ultimate Framework
 * @version 	: 1.1
 * COPYRIGHT    : 2008
 * ------------------------------------------------------
 * 
 * Created on	:  Aug 1, 2008
 * 
 */

// no direct access
defined ( '_FW_EXEC' ) or die ( 'Restricted access' );

class BaseSmiley {
	var $_configPath;
	var $_imageUrl;
	
	function __construct($configFilePath, $imageFolderUrl) {
		$this->_configPath = $configFilePath;
		$this->_imageUrl = $imageFolderUrl;
	}
	
	/**
	 * JS Insert Smiley
	 *
	 * Generates the javascrip function needed to insert smileys into a form field
	 *
	 * @access	public
	 * @param	string	form name
	 * @param	string	field name
	 * @return	string
	 */
	function js_insert_smiley($form_name = '', $form_field = '') {
		return "
				function insert_smiley(smiley)
				{
					document.{$form_name}.{$form_field}.value += \" \" + smiley;
				}";
	}
	// ------------------------------------------------------------------------
	

	/**
	 * Get Clickable Smileys
	 *
	 * Returns an array of image tag links that can be clicked to be inserted 
	 * into a form field.  
	 *
	 * @access	public
	 * @param	string	the URL to the folder containing the smiley images
	 * @return	array
	 */
	function get_clickable_smileys($smileys = NULL) {
		if (! is_array ( $smileys )) {
			if (FALSE === ($smileys = $this->_get_smiley_array ())) {
				return $smileys;
			}
		}
		
		// Add a trailing slash to the file path if needed
		$image_url = preg_replace ( "/(.+?)\/*$/", "\\1/", $this->_imageUrl );
		
		$used = array ();
		foreach ( $smileys as $key => $val ) {
			// Keep duplicates from being used, which can happen if the
			// mapping array contains multiple identical replacements.  For example:
			// :-) and :) might be replaced with the same image so both smileys
			// will be in the array.
			if (isset ( $used [$smileys [$key] [0]] )) {
				continue;
			}
			
			$link [] = "<a href=\"javascript:void(0);\" onClick=\"insert_smiley('" . $key . "')\"><img src=\"" . $image_url . $smileys [$key] [0] . "\" width=\"" . $smileys [$key] [1] . "\" height=\"" . $smileys [$key] [2] . "\" alt=\"" . $smileys [$key] [3] . "\" style=\"border:0;\" /></a>";
			
			$used [$smileys [$key] [0]] = TRUE;
		}
		
		return $link;
	}
	
	// ------------------------------------------------------------------------
	

	/**
	 * Parse Smileys
	 *
	 * Takes a string as input and swaps any contained smileys for the actual image
	 *
	 * @access	public
	 * @param	string	the text to be parsed
	 * @param	string	the URL to the folder containing the smiley images
	 * @return	string
	 */
	function parse_smileys($str = '', $smileys = NULL) {
		if ($this->_imageUrl == '') {
			return $str;
		}
		
		if (! is_array ( $smileys )) {
			if (FALSE === ($smileys = $this->_get_smiley_array ())) {
				return $str;
			}
		}
		
		// Add a trailing slash to the file path if needed
		$image_url = preg_replace ( "/(.+?)\/*$/", "\\1/", $this->_imageUrl );
		
		foreach ( $smileys as $key => $val ) {
			$str = str_replace ( $key, "<img src=\"" . $image_url . $smileys [$key] [0] . "\" width=\"" . $smileys [$key] [1] . "\" height=\"" . $smileys [$key] [2] . "\" alt=\"" . $smileys [$key] [3] . "\" style=\"border:0;\" />", $str );
		}
		
		return $str;
	}
	
	// ------------------------------------------------------------------------
	

	/**
	 * Get Smiley Array
	 *
	 * Fetches the config/smiley.php file
	 *
	 * @access	private
	 * @return	mixed
	 */
	function _get_smiley_array() {
		if (! file_exists ( $this->_configPath )) {
			return FALSE;
		}
		
		include ($this->_configPath);
		
		if (! isset ( $smileys ) or ! is_array ( $smileys )) {
			return FALSE;
		}
		
		return $smileys;
	}

}

?>